<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Interface Swift_CharacterReader | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li class="active"><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Swift_CharacterReader_GenericFixedWidthReader.html">Swift_CharacterReader_GenericFixedWidthReader</a></li>
				<li><a href="class-Swift_CharacterReader_UsAsciiReader.html">Swift_CharacterReader_UsAsciiReader</a></li>
				<li><a href="class-Swift_CharacterReader_Utf8Reader.html">Swift_CharacterReader_Utf8Reader</a></li>
				<li><a href="class-Swift_CharacterReaderFactory_SimpleCharacterReaderFactory.html">Swift_CharacterReaderFactory_SimpleCharacterReaderFactory</a></li>
				<li><a href="class-Swift_Encoder_Base64Encoder.html">Swift_Encoder_Base64Encoder</a></li>
				<li><a href="class-Swift_Encoder_QpEncoder.html">Swift_Encoder_QpEncoder</a></li>
				<li><a href="class-Swift_Encoder_Rfc2231Encoder.html">Swift_Encoder_Rfc2231Encoder</a></li>
				<li><a href="class-Swift_Encoding.html">Swift_Encoding</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li class="active"><a href="class-Swift_CharacterReader.html">Swift_CharacterReader</a></li>
				<li><a href="class-Swift_CharacterReaderFactory.html">Swift_CharacterReaderFactory</a></li>
				<li><a href="class-Swift_Encoder.html">Swift_Encoder</a></li>
			</ul>




		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-Swift.Encoder.html" title="Summary of Swift\Encoder"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Interface Swift_CharacterReader</h1>


	<div class="description">
	
<p>Analyzes characters for a specific character set.</p>

	</div>





	<div>
		<h4>Direct known implementers</h4>
			<a href="class-Swift_CharacterReader_GenericFixedWidthReader.html">Swift_CharacterReader_GenericFixedWidthReader</a>, 
			<a href="class-Swift_CharacterReader_UsAsciiReader.html">Swift_CharacterReader_UsAsciiReader</a>, 
			<a href="class-Swift_CharacterReader_Utf8Reader.html">Swift_CharacterReader_Utf8Reader</a>
	</div>




	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-Swift.html">Swift</a>\<a href="package-Swift.Encoder.html">Encoder</a><br />

				<b>Author:</b>
				Chris Corbyn<br />
				<b>Author:</b>
				Xavier De Cock &lt;<a
href="mailto:xdecock&#64;gmail.com">xdecock&#64;<!---->gmail.com</a>&gt;<br />
		<b>Located at</b> <a href="source-class-Swift_CharacterReader.html#11" title="Go to source code">lib/php/externals/swift/classes/Swift/CharacterReader.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="getCharPositions" id="_getCharPositions">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getCharPositions">#</a>
		<code><a href="source-class-Swift_CharacterReader.html#25" title="Go to source code">getCharPositions</a>( <span>string <var>$string</var></span>, <span>integer <var>$startOffset</var></span>, <span>array <var>&amp; $currentMap</var></span>, <span>mixed <var>&amp; $ignoredChars</var></span> )</code>

		<div class="description short">
			
<p>Returns the complete charactermap</p>

		</div>

		<div class="description detailed hidden">
			
<p>Returns the complete charactermap</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$string</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$startOffset</var></dt>
					<dd><code>integer</code></dd>
					<dt><var>$currentMap</var></dt>
					<dd><code>array</code></dd>
					<dt><var>$ignoredChars</var></dt>
					<dd><code>mixed</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getMapType" id="_getMapType">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getMapType">#</a>
		<code><a href="source-class-Swift_CharacterReader.html#38" title="Go to source code">getMapType</a>( )</code>

		<div class="description short">
			
<p>Returns mapType</p>

		</div>

		<div class="description detailed hidden">
			
<p>Returns mapType</p>






				<h4>Int</h4>
				<div class="list">
						mapType<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="validateByteSequence" id="_validateByteSequence">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_validateByteSequence">#</a>
		<code><a href="source-class-Swift_CharacterReader.html#45" title="Go to source code">validateByteSequence</a>( <span>int[] <var>$bytes</var></span>, <span> <var>$size</var></span> )</code>

		<div class="description short">
			
<p>Returns an integer which specifies how many more bytes to read. A positive
integer indicates the number of more bytes to fetch before invoking this method
again. A value of zero means this is already a valid character. A value of -1
means this cannot possibly be a valid character.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Returns an integer which specifies how many more bytes to read. A positive
integer indicates the number of more bytes to fetch before invoking this method
again. A value of zero means this is already a valid character. A value of -1
means this cannot possibly be a valid character.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$bytes</var></dt>
					<dd><code>int[]</code></dd>
					<dt><var>$size</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getInitialByteSize" id="_getInitialByteSize">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getInitialByteSize">#</a>
		<code><a href="source-class-Swift_CharacterReader.html#57" title="Go to source code">getInitialByteSize</a>( )</code>

		<div class="description short">
			
<p>Returns the number of bytes which should be read to start each character. For
fixed width character sets this should be the number of octets-per-character.
For multibyte character sets this will probably be 1.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Returns the number of bytes which should be read to start each character. For
fixed width character sets this should be the number of octets-per-character.
For multibyte character sets this will probably be 1.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	</table>




	<table class="summary" id="constants">
	<caption>Constants summary</caption>
	<tr data-order="MAP_TYPE_INVALID" id="MAP_TYPE_INVALID">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_CharacterReader.html#20" title="Go to source code"><b>MAP_TYPE_INVALID</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">0x01</span></code></td>
		<td class="description"><div>
			<a href="#MAP_TYPE_INVALID" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="MAP_TYPE_FIXED_LEN" id="MAP_TYPE_FIXED_LEN">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_CharacterReader.html#21" title="Go to source code"><b>MAP_TYPE_FIXED_LEN</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">0x02</span></code></td>
		<td class="description"><div>
			<a href="#MAP_TYPE_FIXED_LEN" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="MAP_TYPE_POSITIONS" id="MAP_TYPE_POSITIONS">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_CharacterReader.html#22" title="Go to source code"><b>MAP_TYPE_POSITIONS</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">0x03</span></code></td>
		<td class="description"><div>
			<a href="#MAP_TYPE_POSITIONS" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
